Skip to content

docs: add svelte installation links#111

Merged
KevinVandy merged 1 commit into
TanStack:mainfrom
Shramkoweb:fix/svelte-instalation-links
Apr 25, 2026
Merged

docs: add svelte installation links#111
KevinVandy merged 1 commit into
TanStack:mainfrom
Shramkoweb:fix/svelte-instalation-links

Conversation

@Shramkoweb
Copy link
Copy Markdown
Contributor

@Shramkoweb Shramkoweb commented Apr 23, 2026

🎯 Changes

Add Svelte framework to the installation docs — tab entry and quick start section with links to guides.

✅ Checklist

  • I have followed the steps in the Contributing guide.
  • I have tested this code locally with pnpm run test:pr.

🚀 Release Impact

  • This change affects published code, and I have generated a changeset.
  • This change is docs/CI/dev-only (no release).

Summary by CodeRabbit

  • Documentation
    • Added Svelte as a supported framework in the installation documentation with package installation information.
    • Created a dedicated Svelte section with links to Quick Start and Svelte-specific hotkeys guides.

@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented Apr 23, 2026

📝 Walkthrough

Walkthrough

Documentation update adds Svelte as a supported framework in the installation guide, including the @tanstack/svelte-hotkeys package in the package-manager tab list and a dedicated Svelte section with links to relevant guides. EOF formatting is also corrected.

Changes

Cohort / File(s) Summary
Svelte Framework Documentation
docs/installation.md
Added @tanstack/svelte-hotkeys to package-manager tabs and created a new Svelte framework section with Quick Start and hotkeys guide links. Fixed trailing newline at end of file.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Poem

🐰 A Svelte new friend has arrived today,
In docs so neat and organized way,
Framework tabs now shine with frame-work pride,
Installation guides open extra wide! ✨

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly and specifically summarizes the main change: adding Svelte installation links to the documentation.
Description check ✅ Passed The description follows the required template structure with all sections completed: Changes section describes the modification clearly, Checklist items are marked appropriately, and Release Impact correctly identifies this as docs-only with no changeset needed.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

Warning

Review ran into problems

🔥 Problems

Git: Failed to clone repository. Please run the @coderabbitai full review command to re-trigger a full review. If the issue persists, set path_filters to include or exclude specific files.


Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

Copy link
Copy Markdown

@coderabbitai coderabbitai Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🧹 Nitpick comments (1)
docs/installation.md (1)

129-129: Good practice: EOF formatting.

Adding a trailing newline at the end of the file follows standard conventions and improves git diff readability.

🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In `@docs/installation.md` at line 129, Add a trailing newline to the end of the
file so the final line "<!-- ::end:framework -->" is followed by a single
newline character; update the file to ensure it ends with a newline to follow
EOF formatting conventions and improve git diffs.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.

Nitpick comments:
In `@docs/installation.md`:
- Line 129: Add a trailing newline to the end of the file so the final line
"<!-- ::end:framework -->" is followed by a single newline character; update the
file to ensure it ends with a newline to follow EOF formatting conventions and
improve git diffs.

ℹ️ Review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

Run ID: 36ac2ed5-d164-4560-97b8-1ffa33d71bfd

📥 Commits

Reviewing files that changed from the base of the PR and between 3104ee4 and 1627cd1.

📒 Files selected for processing (1)
  • docs/installation.md

@Shramkoweb
Copy link
Copy Markdown
Contributor Author

Relates to TanStack/tanstack.com#852

@pkg-pr-new
Copy link
Copy Markdown

pkg-pr-new Bot commented Apr 25, 2026

Open in StackBlitz

@tanstack/angular-hotkeys

npm i https://pkg.pr.new/@tanstack/angular-hotkeys@111

@tanstack/hotkeys

npm i https://pkg.pr.new/@tanstack/hotkeys@111

@tanstack/hotkeys-devtools

npm i https://pkg.pr.new/@tanstack/hotkeys-devtools@111

@tanstack/lit-hotkeys

npm i https://pkg.pr.new/@tanstack/lit-hotkeys@111

@tanstack/preact-hotkeys

npm i https://pkg.pr.new/@tanstack/preact-hotkeys@111

@tanstack/preact-hotkeys-devtools

npm i https://pkg.pr.new/@tanstack/preact-hotkeys-devtools@111

@tanstack/react-hotkeys

npm i https://pkg.pr.new/@tanstack/react-hotkeys@111

@tanstack/react-hotkeys-devtools

npm i https://pkg.pr.new/@tanstack/react-hotkeys-devtools@111

@tanstack/solid-hotkeys

npm i https://pkg.pr.new/@tanstack/solid-hotkeys@111

@tanstack/solid-hotkeys-devtools

npm i https://pkg.pr.new/@tanstack/solid-hotkeys-devtools@111

@tanstack/svelte-hotkeys

npm i https://pkg.pr.new/@tanstack/svelte-hotkeys@111

@tanstack/vue-hotkeys

npm i https://pkg.pr.new/@tanstack/vue-hotkeys@111

@tanstack/vue-hotkeys-devtools

npm i https://pkg.pr.new/@tanstack/vue-hotkeys-devtools@111

commit: 1627cd1

@KevinVandy KevinVandy merged commit 14b1072 into TanStack:main Apr 25, 2026
6 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants